Health Protection Electronic Notification (HPEN)
Domain Message Specification

Version: 1.0; Status: RC1

HPENDiagnosis Tabular View

COCD_TP146034GB01
HPENDiagnosis
This template class constrains the CDA Observation class.
This class holds the notifiable disease and the date of onset of the disease.
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }
Model Attribute Description
The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance
  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }
Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an event.

Implementation in XML Instance
  • The XML attribute moodCode is fixed to "EVN".
[0..1] code (CD { CNE:HPENDiagnosisSnCT } )

Model Attribute Description

The HL7 attribute code is used to hold the notifiable disease, when the notifiable disease code is known. The code must be a SNOMED CT code for a notifiable disease, and this should be supported by a Read code taken directly from the GP system.

NOTE that either a diagnosis code OR a text entry (in the text element) MUST be supplied.

Implementation in XML Instance

The Coded Translated flavour of the CD data type is used to carry the diagnosed notifiable disease code.

The SNOMED CT code shall be carried as the primary diagnosed code as follows:

  • The XML attribute code of the XML element code shall contain the SNOMED CT concept identifier
  • The XML attribute codeSystem of the the XML element code shall contain "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName of the the XML element code shall carry the preferred term of the of the concept

The Read code shall be carried as a translation of the SNOMED CT concept within the XML element translation.

When the Read version in use is Read Version 2

  • The XML attribute code of the XML element translation shall contain the Read code
  • The XML attribute codeSystem of the XML element translation shall contain "2.16.840.1.113883.2.1.6.2"
  • The XML attribute displayName of the XML element translation shall contain the description associated with the code
When the Read version in use is the Read four byte set then
  • The XML attribute code of the XML element translation shall contain the Read code
  • The XML attribute codeSystem of the XML element translation shall contain "2.16.840.1.113883.2.1.6.1"
  • The XML attribute displayName of the XML element translation shall contain the description associated with the code
When the Read version in use is Clinical Terms Version 3 (CTV3) then
  • The XML attribute code of the XML element translation shall contain the Read code
  • The XML attribute codeSystem of the XML element translation shall contain "2.16.840.1.113883.2.1.3.2.4.14"
  • The XML attribute displayName of the XML element translation shall contain the description associated with the code
[0..1] effectiveTime (IVL<TS>)
Model Attribute Description

The HL7 model attribute effectiveTime is used to hold the date and time of the onset of the patient's symptoms.

Implementation in XML Instance

The XML element effectiveTime is used to hold the date and time of symptom onset.

The XML element effectiveTime shall be populated with the date and time of the onset of symptoms in the format yyyymmddhhmmss[+|-ZZzz] where:
  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minute
  • ss is seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy.
[1..1] [M] id (II)
Model Attribute Description

The HL7 attribute id uses an identifier to identify each unique instance of a notifiable disease.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:
  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146034GB01#HPENDiagnosis" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146034GB01#HPENDiagnosis"
[0..1] text (ST)

Model Attribute Description

The HL7 attribute text is used to carry the description of a notifiable disease, when the notifiable disease code is not known.

NOTE that either a diagnosis code OR a text entry MUST be supplied.

Implementation in XML Instance

  • The XML element text is used to hold the description of the notifiable disease.
[1..1] [M] entryRelationship
This template class constrains the CDA Component class.
This class links the disease to the date the diagnosis was made.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }
Model Attribute Description

The HL7 attribute typeCode describes this class as a component.

Implementation in XML Instance
  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }
Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act.

Implementation in XML Instance
  • The XML attribute contextConductionInd is fixed to "true".

[1..1] [M] seperatableInd (BL)
{ Fixed="false" }
Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean value (true or false) to determine whether information associated with the child act may be safely separated from the context of the parent act.

Implementation in XML Instance
  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146034GB01#entryRelationship" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146034GB01#entryRelationship"
[1..1] [M] diagnosisDate (DiagnosisDate)
A link to the date the diagnosis was made.
DiagnosisDate
This template class constrains the CDA Observation class.
This class holds the date the diagnosis of the notifiable disease was made.
Used by: HPENDiagnosis
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }
Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance
  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }
Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an event.

Implementation in XML Instance
  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="DGD" }
Model Attribute Description

The HL7 model attribute code uses a code from the CDAObservationType vocabulary to describe this class as holding the diagnosis date.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
  • The XML attribute code shall contain a fixed value of "DGD"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description "Diagnosis Date"
[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 model attribute effectiveTime is used to hold the date and time the diagnosis was made.

Implementation in XML Instance

The XML element effectiveTime is used to hold the date the diagnosis was made.

The XML element effectiveTime shall be populated with the date and time the diagnosis was made in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minute
  • ss is seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy.

[1..1] [M] templateId (II)
{ Fixed="COCD_TP146034GB01#diagnosisDate" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146034GB01#diagnosisDate"